Add option to use rebar3 fmt instead of standalone erlfmt #4811
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
w0rp
requested changes
Aug 2, 2024
autoload/ale/erlang.vim
Outdated
| call ale#Set('erlang_rebar_executable', 'rebar3') | ||
| call ale#Set('erlang_rebar_use_global', get(g:, 'ale_use_global_executables', 0)) | ||
|
|
||
| function! ale#erlang#GetRebarExecutable(buffer) abort |
There was a problem hiding this comment.
There's a runtime cost in loading this file, and we only have this one function and call it from one place. Let's just move this into the fixer file instead, to avoid this runtime cost.
|
@w0rp Thank you for your feedback! I have addressed the points you raised. Could you please review the changes again? |
| let l:executable = ale#fixers#erlfmt#GetExecutable(a:buffer) | ||
| let l:use_rebar = ale#Var(a:buffer, 'erlang_erlfmt_use_rebar') | ||
|
|
||
| if l:use_rebar |
There was a problem hiding this comment.
It would be clearer if the two cases were handled in separate functions, like this:
function! ale#fixers#erlfmt#Fix(buffer) abort
return ale#Var(a:buffer, 'erlang_erlfmt_use_rebar3')
\ ? s:FixWithRebar3(a:buffer)
\ : s:FixWithEscript(a:buffer)
endfunction
However, it seems to me that from user's perspective it would be better to add separate rebar3_fmt fixer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current implementation of the fixer for erlfmt, an Erlang code formatter, invokes a standalone
erlfmtcommand. However, the standaloneerlfmtcommand is not distributed by default. Instead, erlfmt is often used as a plugin for Rebar3, the de facto build tool for Erlang.This patch introduces a new option
g:ale_erlang_erlfmt_use_rebar, which is disabled by default, allowing the use ofrebar3 fmtinstead.Additionally, this patch fixes a bug that caused the command to read the original source code rather than the stdin.